<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>      Copyright 2010 Regents of the University of Colorado.<a name="line.2"></a>
<FONT color="green">003</FONT>     All rights reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.5"></a>
<FONT color="green">006</FONT>     you may not use this file except in compliance with the License.<a name="line.6"></a>
<FONT color="green">007</FONT>     You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.uimafit.factory.initializable;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.uima.UimaContext;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.uima.jcas.JCas;<a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.uima.resource.ResourceInitializationException;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.uimafit.component.xwriter.IntegerFileNamer;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.uimafit.component.xwriter.XWriter;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.uimafit.component.xwriter.XWriterFileNamer;<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>    /**<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;p&gt;<a name="line.28"></a>
<FONT color="green">029</FONT>     * This interface provides a way of initializing a class with a {@link UimaContext}. The standard<a name="line.29"></a>
<FONT color="green">030</FONT>     * use case of this interface involves situations in which a member variable is declared with an<a name="line.30"></a>
<FONT color="green">031</FONT>     * interface type and the actual class that is used is decided at runtime. When the member variable<a name="line.31"></a>
<FONT color="green">032</FONT>     * is instantiated, it is useful to provide it a {@code UimaContext} so that it can initialize<a name="line.32"></a>
<FONT color="green">033</FONT>     * itself based on configuration parameters.<a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;/p&gt;<a name="line.34"></a>
<FONT color="green">035</FONT>     *<a name="line.35"></a>
<FONT color="green">036</FONT>     * &lt;p&gt;<a name="line.36"></a>
<FONT color="green">037</FONT>     * As an example, consider the component {@link XWriter} which has a member variable of type<a name="line.37"></a>
<FONT color="green">038</FONT>     * {@link XWriterFileNamer} which is an interface that provides a way for {@code XWriter} to come up<a name="line.38"></a>
<FONT color="green">039</FONT>     * with a name each file that is generated given a {@link JCas}. The default<a name="line.39"></a>
<FONT color="green">040</FONT>     * {@code XWriterFileNamer} that is provided, {@link IntegerFileNamer}, provides a single<a name="line.40"></a>
<FONT color="green">041</FONT>     * configuration parameter for specifying a prefix to each file name that is generated. This<a name="line.41"></a>
<FONT color="green">042</FONT>     * parameter is initialized in the {@link IntegerFileNamer#initialize} method. This initialize<a name="line.42"></a>
<FONT color="green">043</FONT>     * method is called because {@code XWriter} instantiates its XWriterFileNamer member variable using<a name="line.43"></a>
<FONT color="green">044</FONT>     * a {@link InitializableFactory#create} method. Therefore, when XWriter is instantiated it should<a name="line.44"></a>
<FONT color="green">045</FONT>     * be given a value for the configuration parameter {@link IntegerFileNamer#PARAM_PREFIX}. See the<a name="line.45"></a>
<FONT color="green">046</FONT>     * unit tests for {@code XWriter} for a complete code example. Note that the implementation of<a name="line.46"></a>
<FONT color="green">047</FONT>     * {@code XWriterFileNamer} does not have to implement {@code Initializable} if it has no need for<a name="line.47"></a>
<FONT color="green">048</FONT>     * the initialize method.<a name="line.48"></a>
<FONT color="green">049</FONT>     * &lt;/p&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>     *<a name="line.50"></a>
<FONT color="green">051</FONT>     * @author Philip Ogren<a name="line.51"></a>
<FONT color="green">052</FONT>     */<a name="line.52"></a>
<FONT color="green">053</FONT>    public interface Initializable {<a name="line.53"></a>
<FONT color="green">054</FONT>    <a name="line.54"></a>
<FONT color="green">055</FONT>            /**<a name="line.55"></a>
<FONT color="green">056</FONT>             * This method will be called automatically if the implementing class is instantiated with<a name="line.56"></a>
<FONT color="green">057</FONT>             * InitializableFactory.<a name="line.57"></a>
<FONT color="green">058</FONT>             *<a name="line.58"></a>
<FONT color="green">059</FONT>             * @param context<a name="line.59"></a>
<FONT color="green">060</FONT>             * @throws ResourceInitializationException<a name="line.60"></a>
<FONT color="green">061</FONT>             */<a name="line.61"></a>
<FONT color="green">062</FONT>            public void initialize(UimaContext context) throws ResourceInitializationException;<a name="line.62"></a>
<FONT color="green">063</FONT>    <a name="line.63"></a>
<FONT color="green">064</FONT>    }<a name="line.64"></a>




























































</PRE>
</BODY>
</HTML>
